build: generate custom elements manifest #9556
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Custom Elements Manifest is the community's chosen specification for json-formatted documentation. It is similar to Stencil's docs-json, however there is more community support. package: https://github.com/open-wc/custom-elements-manifest spec: https://github.com/webcomponents/custom-elements-manifest
github-actions
bot
added
the
chore
benelan
requested review from
jcfranco,
driskull and
geospatialem
as code owners
|
This PR has been automatically marked as stale because it has not had recent activity. Please close your PR if it is no longer relevant. Thank you for your contributions. |
github-actions
bot
added
the
Stale
|
closing in favor of #10482 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Custom Elements Manifest is the community's chosen specification for json-formatted documentation. It is similar to Stencil's docs-json, however there is more community support. The analyzer npm package added builtin support for Stencil projects since the last time I checked!
Example output for calcite-accordion
{ "kind": "javascript-module", "path": "src/components/accordion/accordion.tsx", "declarations": [ { "kind": "class", "description": "", "name": "Accordion", "slots": [ { "description": "A slot for adding `calcite-accordion-item`s. `calcite-accordion` cannot be nested, however `calcite-accordion-item`s can.", "name": "" } ], "members": [ { "kind": "field", "name": "appearance", "type": { "text": "Extract<\"solid\" | \"transparent\", Appearance>" }, "default": "\"solid\"", "description": "Specifies the appearance of the component." }, { "kind": "field", "name": "iconPosition", "type": { "text": "Extract<\"start\" | \"end\", Position>" }, "default": "\"end\"", "description": "Specifies the placement of the icon in the header." }, { "kind": "field", "name": "iconType", "type": { "text": "Extract<\"chevron\" | \"caret\" | \"plus-minus\", IconType>" }, "default": "\"chevron\"", "description": "Specifies the type of the icon in the header." }, { "kind": "field", "name": "scale", "type": { "text": "Scale" }, "default": "\"m\"", "description": "Specifies the size of the component." }, { "kind": "field", "name": "selectionMode", "type": { "text": "Extract<\n \"single\" | \"single-persist\" | \"multiple\",\n SelectionMode\n >" }, "default": "\"multiple\"", "description": "Specifies the selection mode of the component, where:\n\n`\"multiple\"` allows any number of selections,\n\n`\"single\"` allows only one selection, and\n\n`\"single-persist\"` allows one selection and prevents de-selection." }, { "kind": "method", "name": "handlePropsChange", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "render", "return": { "type": { "text": "VNode" } } }, { "kind": "method", "name": "updateActiveItemOnChange", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "field", "name": "el", "type": { "text": "HTMLCalciteAccordionElement" } }, { "kind": "field", "name": "mutationObserver" }, { "kind": "method", "name": "updateAccordionItems", "privacy": "private", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "appearance", "fieldName": "appearance", "type": { "text": "Extract<\"solid\" | \"transparent\", Appearance>" } }, { "name": "icon-position", "fieldName": "iconPosition", "type": { "text": "Extract<\"start\" | \"end\", Position>" } }, { "name": "icon-type", "fieldName": "iconType", "type": { "text": "Extract<\"chevron\" | \"caret\" | \"plus-minus\", IconType>" } }, { "name": "scale", "fieldName": "scale", "type": { "text": "Scale" } }, { "name": "selection-mode", "fieldName": "selectionMode", "type": { "text": "Extract<\n \"single\" | \"single-persist\" | \"multiple\",\n SelectionMode\n >" } } ], "tagName": "calcite-accordion", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "Accordion", "declaration": { "name": "Accordion", "module": "src/components/accordion/accordion.tsx" } }, { "kind": "custom-element-definition", "name": "calcite-accordion", "declaration": { "name": "Accordion", "module": "src/components/accordion/accordion.tsx" } } ] },